\section{Dokumentacja klasy Usart}
\label{class_usart}\index{Usart@{Usart}}


{\ttfamily \#include $<$Usart.h$>$}

\subsection*{Metody publiczne}
\begin{DoxyCompactItemize}
\item 
{\bf Usart} ()  throw (std::string)
\item 
{\bf $\sim$Usart} ()
\item 
std::string {\bf Read} ()
\item 
void {\bf Write} (std::string str)
\end{DoxyCompactItemize}


\subsection{Opis szczegółowy}
Klasa odpowiadająca za komunikację komputera z robotem za pomocą interfejsu USART. 

\subsection{Dokumentacja konstruktora i destruktora}
\index{Usart@{Usart}!Usart@{Usart}}
\index{Usart@{Usart}!Usart@{Usart}}
\subsubsection[{Usart}]{\setlength{\rightskip}{0pt plus 5cm}Usart::Usart (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)  throw (std::string)}\label{class_usart_ac22ce0cdab0fadae346056a409c90591}
Konstruktor włącza i ustawia parametry urządzenia USB komunikującego się z platformą 
\begin{DoxyExceptions}{Wyjątki}
{\em w} & razie niepowodzenia wyrzuca wyjątek std::string zawierający komunikat o błędzie \\
\hline
\end{DoxyExceptions}
\index{Usart@{Usart}!$\sim$Usart@{$\sim$Usart}}
\index{$\sim$Usart@{$\sim$Usart}!Usart@{Usart}}
\subsubsection[{$\sim$Usart}]{\setlength{\rightskip}{0pt plus 5cm}Usart::$\sim$Usart (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_usart_a91f3684acbb201d70cd0aafae5e9f3ee}
Destruktor zamykający urządzenie USB 

\subsection{Dokumentacja funkcji składowych}
\index{Usart@{Usart}!Read@{Read}}
\index{Read@{Read}!Usart@{Usart}}
\subsubsection[{Read}]{\setlength{\rightskip}{0pt plus 5cm}string Usart::Read (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{class_usart_a3e7c1ae302c6e70ad15648ea08d20aff}
Metoda pozwalająca odczytać ciąg nadawany z platformy \begin{DoxyReturn}{Zwraca}
wartość zwracana to ciąg znaków opakowany klasą std::string 
\end{DoxyReturn}
\index{Usart@{Usart}!Write@{Write}}
\index{Write@{Write}!Usart@{Usart}}
\subsubsection[{Write}]{\setlength{\rightskip}{0pt plus 5cm}void Usart::Write (
\begin{DoxyParamCaption}
\item[{std::string}]{str}
\end{DoxyParamCaption}
)}\label{class_usart_a3d0bf5cc89c988387581658626f4d6cd}
Metoda zapisująca ciąg do platformy. 
\begin{DoxyParams}{Parametry}
{\em str} & obiekt przechowujący napis. \\
\hline
\end{DoxyParams}


Dokumentacja dla tej klasy została wygenerowana z plików:\begin{DoxyCompactItemize}
\item 
inc/{\bf Usart.h}\item 
src/{\bf Usart.cpp}\end{DoxyCompactItemize}
